controller.js ➔ ... ➔ $.done - Code Metrics - Inspection of "79: Webpack setup and restructured client behaviou..." - janis91/ocr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#90)

by Janis

created 2017-05-29 22:31 UTC

controller.js ➔ ... ➔ $.done B

↳ Parent: controller.js ➔ ... ➔ loopForStatus

Complexity

Conditions	5
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	8.8571
c	0
b	0
f	0
cc	5
nc	8
nop	0

/**
 * nextCloud - ocr
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Janis Koehr <[email protected]>
 * @copyright Janis Koehr 2017
 */
(function (OC, OCA, window, $, _) {
    'use strict';
    /**
     * Integrates the service with the view.
     * @public
     * @class Ocr.Controller
     * @param Ocr.View
     * @param Ocr.Util
     * @param Ocr.HttpService

     */
    var Controller = function (view, util, httpService) {
        /** Constructor */
        /** Instance of the OCA.Ocr.View. */
        var ocrView;
        view !== undefined ? ocrView = view : console.error('OCR view is not defined.');
function someFunction(x) {
    (x > 0) ? callFoo() : callBar();
}

// JSHint expects you to assign the result to a variable:
function someFunction(x) {
    var rs = (x > 0) ? callFoo() : callBar();
}

// If you do not use the result, you could also use if statements in the
// case above.
function someFunction(x) {
    if (x > 0) {
        callFoo();
    } else {
        callBar();
    }
}
        /** Instance of the OCA.Ocr.Util. */
        var ocrUtil;
        util !== undefined ? ocrUtil = util : console.error('OCR util is not defined.');
function someFunction(x) {
    (x > 0) ? callFoo() : callBar();
}

// JSHint expects you to assign the result to a variable:
function someFunction(x) {
    var rs = (x > 0) ? callFoo() : callBar();
}

// If you do not use the result, you could also use if statements in the
// case above.
function someFunction(x) {
    if (x > 0) {
        callFoo();
    } else {
        callBar();
    }
}
        /** Instance of the OCA.Ocr.HttpService. */
        var ocrHttpService;
        httpService !== undefined ? ocrHttpService = httpService : console.error('OCR http service is not defined.');
function someFunction(x) {
    (x > 0) ? callFoo() : callBar();
}

// JSHint expects you to assign the result to a variable:
function someFunction(x) {
    var rs = (x > 0) ? callFoo() : callBar();
}

// If you do not use the result, you could also use if statements in the
// case above.
function someFunction(x) {
    if (x > 0) {
        callFoo();
    } else {
        callBar();
    }
}
        /** Load the languages that are available for processing. */
        var languages = ocrHttpService.loadAvailableLanguages();

        languages.length > 0 ? '' : console.error('No languages available for OCR processing. Please make sure, that the Docker Container is up and running.');
function someFunction(x) {
    (x > 0) ? callFoo() : callBar();
}

// JSHint expects you to assign the result to a variable:
function someFunction(x) {
    var rs = (x > 0) ? callFoo() : callBar();
}

// If you do not use the result, you could also use if statements in the
// case above.
function someFunction(x) {
    if (x > 0) {
        callFoo();
    } else {
        callBar();
    }
}
        /** Currently selected files. */
        var selectedFiles = [];
        /** Current status. */
        var status = {};

        /**
         * Sets the filtered/cleaned selectedFiles array.
         * @private
         * @param {Array<File>} files 
         */
        var setSelectedFiles = function (files) {
            files = ocrUtil.shrinkData(ocrUtil.filterFilesWithMimeTypes(files));

            selectedFiles = files;
        }


        /**
         * Gets the selectedFiles array
         * @private
         * @returns {Array<File>}
         */
        var getSelectedFiles = function () {
            return selectedFiles;
        }


        /**
         * Sets the retrieved status.
         * @private
         * @param {Object} status

         */
        var setStatus = function (state) {
            status = state;
        }


        /**
         * Gets the retrieved status.
         * @private
         * @returns {Object}
         */
        var getStatus = function () {
            return status;
        }


        /**
         * Checks if the click events target was the OCR dropdown or not.
         * @param {Event} event 
         */
        var clickOnOtherEvent = function (event) {
            ocrView.checkClickOther(event) ? setSelectedFiles([]) : '';
function someFunction(x) {
    (x > 0) ? callFoo() : callBar();
}

// JSHint expects you to assign the result to a variable:
function someFunction(x) {
    var rs = (x > 0) ? callFoo() : callBar();
}

// If you do not use the result, you could also use if statements in the
// case above.
function someFunction(x) {
    if (x > 0) {
        callFoo();
    } else {
        callBar();
    }
}
        }


        /**
         * Triggers the rendering of the OCR dropdown for a single file action.
         * Is the Actionhandler which is registered within the registerFileActions method.
         * @link registerFileActions
         * @private
         * @param {*} file 
         * @param {*} context 
         */
        var fileActionHandler = function (file, context) {
            var id = context.$file.attr('data-id');
            var mimetype = context.fileActions.getCurrentMimeType();
            var files = [{ id: id, mimetype: mimetype }];
            setSelectedFiles(files);
            ocrView.renderFileAction(file, languages);

        }


        /**
         * Registers the FileAction options in the file actions menu for pdf and images.
         * @private
         */
        var registerFileActions = function () {
            // Register FileAction for mimetype pdf
            OCA.Files.fileActions.registerAction({
                name: 'Ocr',
                displayName: t('ocr', 'OCR'),
                order: 100,
                mime: 'application/pdf',
                permissions: OC.PERMISSION_UPDATE,
                altText: t('ocr', 'OCR'),
                iconClass: 'icon-ocr',
                actionHandler: fileActionHandler
            });
            // Register FileAction for mimetype image
            OCA.Files.fileActions.registerAction({
                name: 'Ocr',
                displayName: t('ocr', 'OCR'),
                order: 100,
                mime: 'image',
                permissions: OC.PERMISSION_UPDATE,
                altText: t('ocr', 'OCR'),
                iconClass: 'icon-ocr',
                actionHandler: fileActionHandler
            });
        }


        /**
         * Triggers the rendering of the OCR dropdown for the top bar
         * selected files action button and sets the selectedFiles.
         * @private
         */
        var clickOnTopBarSelectedFilesActionButton = function () {
            ocrView.renderFileAction(undefined, languages);

            setSelectedFiles(OCA.Files.App.fileList.getSelectedFiles());
        }


        /**
         * Triggers the view to show the selected files action button in the top bar
         * and sets the selectedFiles array.
         * @private
         */
        var toggleSelectedFilesActionButton = function () {
            var selFiles = OCA.Files.App.fileList.getSelectedFiles();
            if (selFiles.length > 0 && typeof selFiles !== undefined) {
                ocrView.toggleSelectedFilesActionButton(true);

                setSelectedFiles(selFiles);
            } else {
                ocrView.toggleSelectedFilesActionButton(false);
                setSelectedFiles([]);
            }
        }


        /**
         * Triggers the view to hide the selected files action button in the top bar
         * and empties the selectedFiles array.
         * @private
         */
        var hideSelectedFilesActionButton = function () {
            ocrView.toggleSelectedFilesActionButton(false);

            setSelectedFiles([]);
        }


        /**
         * Retrieves the status of the OCR process.
         * @private
         * @returns {$.Deferred}
         */
        var checkStatus = function () {
            var deferred = $.Deferred();
            ocrHttpService.checkStatus().done(function (status) {

                setStatus(status);
                deferred.resolve(status);
            }).fail(function (jqXHR) {
                deferred.reject(jqXHR.responseText);
            });
            return deferred.promise();
        }


        /** 
         * Reloads the OCA.Files.App.fileList. 
         * @private
         */
        var updateFileList = function () {
            OCA.Files.App.fileList.reload();
            toggleSelectedActionButton();
        }


        /**
         * Trigger the pending notification for the first time (with initialcount)
         * or after that without initialcount (undefined).
         * @private
         * @param {boolean} force - If new files in queue or already in the regular loop.
         * @param {number} initialcount - How much files initially to process (number or undefined).
         */
        var togglePendingState = function (force, initialcount) {
            var count;
            var pendingcount = getStatus().pending;
            initialcount !== undefined ? count = initialcount : count = pendingcount;
function someFunction(x) {
    (x > 0) ? callFoo() : callBar();
}

// JSHint expects you to assign the result to a variable:
function someFunction(x) {
    var rs = (x > 0) ? callFoo() : callBar();
}

// If you do not use the result, you could also use if statements in the
// case above.
function someFunction(x) {
    if (x > 0) {
        callFoo();
    } else {
        callBar();
    }
}
            ocrView.togglePendingNotification(force, count);

        }


        /**
         * Loops as long as there are pending files in the OCR queue.
         * @private
         */
        var loopForStatus = function () {
            $.when(checkStatus()).done(function () {
                if (getStatus().failed > 0) { ocrView.displayError(n('ocr', 'OCR processing for %n file failed. For details please go to your personal settings.', 'OCR processing for %n files failed. For details please go to your personal settings.', getStatus().failed)); }

                if (getStatus().pending > 0) {
                    if (getStatus().processed > 0) { updateFileList(); }
                    togglePendingState(false);
                    setTimeout($.proxy(loopForStatus, this), 4500);
                } else {
                    if (getStatus().processed > 0) { updateFileList(); }
                    togglePendingState(false);
                }
            }).fail(function (message) {
                ocrView.displayError(t('ocr', 'OCR status could not be retrieved:') + ' ' + message);

                setTimeout($.proxy(loopForStatus, self), 4500);

            });
        }


        /**
         * Triggers the OCR process for the selectedFiles array
         * and toggles the "pending" state for the ocr process.
         * @private
         */
		var clickOnProcessButtonEvent = function () {
			if (getSelectedFiles().length == 0) {

				ocrView.displayError(t('ocr', 'OCR processing failed:') + ' ' + t('ocr', 'Mimetype not supported.'));

				ocrView.destroyDropdown();
			} else {
				var selectedLanguages = $('#ocrLanguage').select2('val');
				ocrHttpService.process(getSelectedFiles(), selectedLanguages).done(function (status) {

					togglePendingState(true, getSelectedFiles().length);
					setSelectedFiles([]);
					setTimeout($.proxy(loopForStatus, this), 4500);
				}).fail(function (jqXHR) {
					ocrView.displayError(t('ocr', 'OCR processing failed:') + ' ' + jqXHR.responseText);

				}).always(function () {
					ocrView.destroyDropdown();

				});
			}
		}


        /**
         * Registers the events and the appropriate methods of the view.
         * @private
         */
        var registerEvents = function () {
            // Click on another element then the dropdown
            $(document).click(function (event) {
                clickOnOtherEvent(event);
            });
            // Click on process button
            $(document).on('click', '#processOCR', function () {
                clickOnProcessButtonEvent();
            });
            // Click on top bar OCR button
            $(document).on('click', '#selectedFilesOCR', function () {
                clickOnTopBarSelectedFilesActionButton();
                return false;
            });

            // Register click events on file menu OCR option
            registerFileActions();

            // Register checkbox events
            _.defer(function () {
                OCA.Files.App.fileList.$fileList.on('change', 'td.filename>.selectCheckBox', _.bind(toggleSelectedFilesActionButton, this));
                OCA.Files.App.fileList.$el.find('.select-all').click(_.bind(toggleSelectedFilesActionButton, this));
                OCA.Files.App.fileList.$el.find('.delete-selected').click(_.bind(hideSelectedFilesActionButton, this));
            });
        }


        this.init = function () {
            registerEvents();
            ocrView.renderSelectedFilesActionButton();

            loopForStatus();
        }


        this.destroy = function () {
            ocrView.destroy();

            OCA.Files.fileActions.clear();
            OCA.Files.fileActions.registerDefaultActions();
        }

    }


	/**
	 * Init OCR Controller
	 */
    /** We have to be in the Files App! */
    if (!OCA.Files) {
        return;
    }
    /** Escape when the requested file is public.php */
    if (/(public)\.php/i.exec(window.location.href) !== null) {
        return;
    }
    /** Create namespace Ocr */
    if (!OCA.Ocr) {
        OCA.Ocr = {};
    }
    OCA.Ocr.Controller = Controller;

    /** global: OC, OCA */
})(OC, OCA, window, jQuery, _);



1			/**
2			* nextCloud - ocr
3			*
4			* This file is licensed under the Affero General Public License version 3 or
5			* later. See the COPYING file.
6			*
7			* @author Janis Koehr <[email protected]>
8			* @copyright Janis Koehr 2017
9			*/
10			(function (OC, OCA, window, $, _) {
11			'use strict';
12			/**
13			* Integrates the service with the view.
14			* @public
15			* @class Ocr.Controller
16			* @param Ocr.View
17			* @param Ocr.Util
18			* @param Ocr.HttpService
			0 ignored issues – show Documentation introduced 2017-05-29 22:44 UTC by Report Bug Copy Issue Report The parameter `Ocr.HttpService` does not exist. Did you maybe forget to remove this comment? Loading history...
19			*/
20			var Controller = function (view, util, httpService) {
21			/** Constructor */
22			/** Instance of the OCA.Ocr.View. */
23			var ocrView;
24			view !== undefined ? ocrView = view : console.error('OCR view is not defined.');
			0 ignored issues – show Bug introduced 2017-05-29 22:44 UTC by Report Bug Copy Issue Report Did you forget to assign or call a function? This error message can for example pop up if you forget to assign the result of a function call to a variable or pass it to another function: function someFunction(x) { (x > 0) ? callFoo() : callBar(); } // JSHint expects you to assign the result to a variable: function someFunction(x) { var rs = (x > 0) ? callFoo() : callBar(); } // If you do not use the result, you could also use if statements in the // case above. function someFunction(x) { if (x > 0) { callFoo(); } else { callBar(); } } Loading history...
25			/** Instance of the OCA.Ocr.Util. */
26			var ocrUtil;
27			util !== undefined ? ocrUtil = util : console.error('OCR util is not defined.');
			0 ignored issues – show Bug introduced 2017-05-29 22:44 UTC by Report Bug Copy Issue Report Did you forget to assign or call a function? This error message can for example pop up if you forget to assign the result of a function call to a variable or pass it to another function: function someFunction(x) { (x > 0) ? callFoo() : callBar(); } // JSHint expects you to assign the result to a variable: function someFunction(x) { var rs = (x > 0) ? callFoo() : callBar(); } // If you do not use the result, you could also use if statements in the // case above. function someFunction(x) { if (x > 0) { callFoo(); } else { callBar(); } } Loading history...
28			/** Instance of the OCA.Ocr.HttpService. */
29			var ocrHttpService;
30			httpService !== undefined ? ocrHttpService = httpService : console.error('OCR http service is not defined.');
			0 ignored issues – show Bug introduced 2017-05-29 22:44 UTC by Report Bug Copy Issue Report Did you forget to assign or call a function? This error message can for example pop up if you forget to assign the result of a function call to a variable or pass it to another function: function someFunction(x) { (x > 0) ? callFoo() : callBar(); } // JSHint expects you to assign the result to a variable: function someFunction(x) { var rs = (x > 0) ? callFoo() : callBar(); } // If you do not use the result, you could also use if statements in the // case above. function someFunction(x) { if (x > 0) { callFoo(); } else { callBar(); } } Loading history...
31			/** Load the languages that are available for processing. */
32			var languages = ocrHttpService.loadAvailableLanguages();
			0 ignored issues – show Bug introduced 2017-05-29 22:44 UTC by Report Bug Copy Issue Report The variable `ocrHttpService` seems to not be initialized for all possible execution paths. Loading history...
33			languages.length > 0 ? '' : console.error('No languages available for OCR processing. Please make sure, that the Docker Container is up and running.');
			0 ignored issues – show Bug introduced 2017-05-29 22:44 UTC by Report Bug Copy Issue Report Did you forget to assign or call a function? This error message can for example pop up if you forget to assign the result of a function call to a variable or pass it to another function: function someFunction(x) { (x > 0) ? callFoo() : callBar(); } // JSHint expects you to assign the result to a variable: function someFunction(x) { var rs = (x > 0) ? callFoo() : callBar(); } // If you do not use the result, you could also use if statements in the // case above. function someFunction(x) { if (x > 0) { callFoo(); } else { callBar(); } } Loading history...
34			/** Currently selected files. */

janis91 / ocr

Pull Request — master (#90)

controller.js ➔ ... ➔ $.done B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like